feat: list available connectors configs (#62)

Signed-off-by: Lawrence Zawila <[email protected]>

internal/app/api/connectorconfigs.go

@@ -0,0 +1,40 @@
+package api
+
+import (
+	"encoding/json"
+	"net/http"
+
+	"github.com/formancehq/payments/internal/pkg/connectors/currencycloud"
+	"github.com/formancehq/payments/internal/pkg/connectors/dummypay"
+	"github.com/formancehq/payments/internal/pkg/connectors/modulr"
+	"github.com/formancehq/payments/internal/pkg/connectors/stripe"
+	"github.com/formancehq/payments/internal/pkg/connectors/wise"
+
+	"github.com/formancehq/payments/internal/pkg/configtemplate"
+	"github.com/formancehq/payments/internal/pkg/connectors/bankingcircle"
+)
+
+func connectorConfigsHandler() http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		// TODO: It's not ideal to re-identify available connectors
+		// Refactor it when refactoring the HTTP lib.
+
+		configs := configtemplate.BuildConfigs(
+			bankingcircle.Config{},
+			currencycloud.Config{},
+			dummypay.Config{},
+			modulr.Config{},
+			stripe.Config{},
+			wise.Config{},
+		)
+
+		w.Header().Set("Content-Type", "application/json")
+
+		err := json.NewEncoder(w).Encode(configs)
+		if err != nil {
+			handleServerError(w, r, err)
+
+			return
+		}
+	}
+}

internal/app/api/module.go

@@ -99,6 +99,8 @@ func httpRouter(db *mongo.Database, client *mongo.Client, handlers []connectorHa
 	authGroup.HandleFunc("/connectors", readConnectorsHandler(db))
 	connectorGroup := authGroup.PathPrefix("/connectors").Subrouter()
 
+	connectorGroup.Path("/configs").Handler(connectorConfigsHandler())
+
 	for _, h := range handlers {
 		connectorGroup.PathPrefix("/" + h.Name).Handler(
 			http.StripPrefix("/connectors", h.Handler),

internal/pkg/configtemplate/template.go

@@ -0,0 +1,35 @@
+package configtemplate
+
+type Configs map[string]Config
+
+type Config map[string]Parameter
+
+type Parameter struct {
+	DataType Type `json:"dataType"`
+	Required bool `json:"required"`
+}
+
+type TemplateBuilder interface {
+	BuildTemplate() (string, Config)
+}
+
+func BuildConfigs(builders ...TemplateBuilder) Configs {
+	configs := make(map[string]Config)
+	for _, builder := range builders {
+		name, config := builder.BuildTemplate()
+		configs[name] = config
+	}
+
+	return configs
+}
+
+func NewConfig() Config {
+	return make(map[string]Parameter)
+}
+
+func (c *Config) AddParameter(name string, dataType Type, required bool) {
+	(*c)[name] = Parameter{
+		DataType: dataType,
+		Required: required,
+	}
+}

internal/pkg/configtemplate/types.go

@@ -0,0 +1,9 @@
+package configtemplate
+
+type Type string
+
+const (
+	TypeString                  Type = "string"
+	TypeDurationNs              Type = "duration ns"
+	TypeDurationUnsignedInteger Type = "unsigned integer"
+)

internal/pkg/connectors/bankingcircle/config.go

@@ -1,5 +1,7 @@
 package bankingcircle
 
+import "github.com/formancehq/payments/internal/pkg/configtemplate"
+
 type Config struct {
 	Username              string `json:"username" yaml:"username" bson:"username"`
 	Password              string `json:"password" yaml:"password" bson:"password"`
@@ -26,3 +28,14 @@ func (c Config) Validate() error {
 
 	return nil
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("username", configtemplate.TypeString, true)
+	cfg.AddParameter("password", configtemplate.TypeString, true)
+	cfg.AddParameter("endpoint", configtemplate.TypeString, true)
+	cfg.AddParameter("authorizationEndpoint", configtemplate.TypeString, true)
+
+	return connectorName, cfg
+}

internal/pkg/connectors/currencycloud/config.go

@@ -3,6 +3,8 @@ package currencycloud
 import (
 	"encoding/json"
 	"time"
+
+	"github.com/formancehq/payments/internal/pkg/configtemplate"
 )
 
 type Config struct {
@@ -67,3 +69,14 @@ func (d *Duration) UnmarshalJSON(b []byte) error {
 		return ErrDurationInvalid
 	}
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("loginID", configtemplate.TypeString, true)
+	cfg.AddParameter("apiKey", configtemplate.TypeString, true)
+	cfg.AddParameter("endpoint", configtemplate.TypeString, false)
+	cfg.AddParameter("pollingPeriod", configtemplate.TypeDurationNs, true)
+
+	return connectorName, cfg
+}

internal/pkg/connectors/dummypay/config.go

@@ -3,6 +3,8 @@ package dummypay
 import (
 	"fmt"
 
+	"github.com/formancehq/payments/internal/pkg/configtemplate"
+
 	"github.com/formancehq/payments/internal/pkg/connectors"
 )
 
@@ -19,29 +21,39 @@ type Config struct {
 }
 
 // String returns a string representation of the configuration.
-func (cfg Config) String() string {
+func (c Config) String() string {
 	return fmt.Sprintf("directory: %s, filePollingPeriod: %s, fileGenerationPeriod: %s",
-		cfg.Directory, cfg.FilePollingPeriod.String(), cfg.FileGenerationPeriod.String())
+		c.Directory, c.FilePollingPeriod.String(), c.FileGenerationPeriod.String())
 }
 
 // Validate validates the configuration.
-func (cfg Config) Validate() error {
+func (c Config) Validate() error {
 	// require directory path to be present
-	if cfg.Directory == "" {
+	if c.Directory == "" {
 		return ErrMissingDirectory
 	}
 
 	// check if file polling period is set properly
-	if cfg.FilePollingPeriod.Duration <= 0 {
+	if c.FilePollingPeriod.Duration <= 0 {
 		return fmt.Errorf("filePollingPeriod must be greater than 0: %w",
 			ErrFilePollingPeriodInvalid)
 	}
 
 	// check if file generation period is set properly
-	if cfg.FileGenerationPeriod.Duration <= 0 {
+	if c.FileGenerationPeriod.Duration <= 0 {
 		return fmt.Errorf("fileGenerationPeriod must be greater than 0: %w",
 			ErrFileGenerationPeriodInvalid)
 	}
 
 	return nil
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("directory", configtemplate.TypeString, true)
+	cfg.AddParameter("filePollingPeriod", configtemplate.TypeDurationNs, true)
+	cfg.AddParameter("fileGenerationPeriod", configtemplate.TypeDurationNs, false)
+
+	return connectorName, cfg
+}

internal/pkg/connectors/modulr/config.go

@@ -1,5 +1,7 @@
 package modulr
 
+import "github.com/formancehq/payments/internal/pkg/configtemplate"
+
 type Config struct {
 	APIKey    string `json:"apiKey" bson:"apiKey"`
 	APISecret string `json:"apiSecret" bson:"apiSecret"`
@@ -17,3 +19,13 @@ func (c Config) Validate() error {
 
 	return nil
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("apiKey", configtemplate.TypeString, true)
+	cfg.AddParameter("apiSecret", configtemplate.TypeString, true)
+	cfg.AddParameter("endpoint", configtemplate.TypeString, false)
+
+	return connectorName, cfg
+}

internal/pkg/connectors/stripe/config.go

@@ -4,6 +4,8 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/formancehq/payments/internal/pkg/configtemplate"
+
 	"github.com/formancehq/payments/internal/pkg/connectors"
 )
 
@@ -28,3 +30,13 @@ func (c Config) Validate() error {
 type TimelineConfig struct {
 	PageSize uint64 `json:"pageSize" yaml:"pageSize" bson:"pageSize"`
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("apiKey", configtemplate.TypeString, true)
+	cfg.AddParameter("pollingPeriod", configtemplate.TypeDurationNs, false)
+	cfg.AddParameter("pageSize", configtemplate.TypeDurationUnsignedInteger, false)
+
+	return connectorName, cfg
+}

internal/pkg/connectors/wise/config.go

@@ -1,5 +1,7 @@
 package wise
 
+import "github.com/formancehq/payments/internal/pkg/configtemplate"
+
 type Config struct {
 	APIKey string `json:"apiKey" yaml:"apiKey" bson:"apiKey"`
 }
@@ -11,3 +13,11 @@ func (c Config) Validate() error {
 
 	return nil
 }
+
+func (c Config) BuildTemplate() (string, configtemplate.Config) {
+	cfg := configtemplate.NewConfig()
+
+	cfg.AddParameter("apiKey", configtemplate.TypeString, true)
+
+	return connectorName, cfg
+}

swagger.yml

@@ -58,7 +58,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Payment'
-
   /connectors:
     get:
       summary: Get all installed connectors
@@ -73,7 +72,20 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ListConnectorsResponse'
-
+  /connectors/configs:
+    get:
+      summary: Get all available connectors configs
+      tags:
+      - Payments
+      operationId: getAllConnectorsConfigs
+      description: Get all available connectors configs
+      responses:
+        200:
+          description: List of available connectors configs
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListConnectorsConfigsResponse'
   /connectors/{connector}:
     post:
       summary: Install connector